print bookmark

Type

command

Summary

Creates a document outline in a PDF generated by the pdf printing commands.

Syntax

print [ unicode ] bookmark <titleString> [ with level <levelNum> ] [ at <locationPoint> ] [ initially { open | closed }]

Description

Use the print bookmark command to create a document outline in a PDF generated by the pdf printing commands.

The print bookmark command allows the creation of a document outline in PDFs generated by the pdf printing commands. Individual entries in the document outline are referred to as 'bookmarks'.

If the unicode adjective is specified, then titleString is interpreted as a UTF-16 encoded string, otherwise it is interpreted as the native (single-byte) text encoding.

If levelNum is not present, then the entry is inserted at the level of the previously inserted item, defaulting to the top-most level if no previous entries have been made.

If locationPoint is not present, the top-left of the current page is taken as the location.

If an initially clause is present it determines the default 'open' state of the bookmark item. Bookmarks are open by default.

Parameters

Name	Type	Description
titleString		A text string indicating the name of the bookmark.
levelNum	integer	A number indicating the depth at which the entry should be placed.
locationPoint		A point in the form x,y describing where on the current page the bookmark should refer.

Examples

print bookmark "Chapter 1"

print bookmark "Chapter 1.1" with level 2 at 100,150

Related

command: cancel printing, print anchor, print link, open printing to pdf

glossary: point

Compatibility and Support

Introduced

LiveCode 4.6

OS

mac

windows

linux

ios

Platforms

desktop

mobile